[beta] Delete orders from a plan

Delete one or more orders from a plan. Pass either orderIds (a comma-separated list) or deleteAll=true; exactly one is required. Orders are automatically unassigned from their routes before deletion.

Beta: This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have RoutePlanning APIs enabled for your organization.

Rate limit: 5 requests/sec (learn more about rate limits here).

To use this endpoint, select Write Routes under the Driver Workflow category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

DELETE /hub/plan/orders

[beta] Delete orders from a plan

cURL

curl --request DELETE \
  --url https://api.samsara.com/hub/plan/orders \
  --header 'Authorization: Bearer <token>'

204

This response has no body data.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

planId · string · required

The plan identifier

orderIds · string

Comma-separated list of order IDs to delete. Mutually exclusive with deleteAll=true; exactly one of the two must be provided.

deleteAll · boolean

When true, every order in the plan is deleted. Must not be combined with orderIds. Must be set to true explicitly — false is equivalent to omitting the parameter and requires orderIds to be supplied.

Response

204